[managementpartner] Add command example #8969
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @cxznmhdcxz, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds an example usage snippet to the Create command’s docstring for the managementpartner extension.
- Inserts a
:example:directive in theCreateclass docstring - Provides a sample
az managementpartner createcommand
Comments suppressed due to low confidence (2)
src/managementpartner/azext_managementpartner/aaz/latest/managementpartner/_create.py:20
- [nitpick] The example directive currently repeats the summary text. Remove the duplicated description and use a standalone
:example:header so that only the command is shown under the example.
:example: Associates a Microsoft Partner Network(MPN) ID to the current authenticated user or service principal.
src/managementpartner/azext_managementpartner/aaz/latest/managementpartner/_create.py:21
- Indent the example command by four spaces under the
:example:directive to ensure it renders correctly in the generated help output.
az managementpartner create --partner-id 12345678-1234-1234-1234-123456789012
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
Hi @cxznmhdcxz Release SuggestionsModule: managementpartner
Notes
|
3 participants
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.